<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>ADF4351: Reg Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ADF4351
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classReg.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classReg-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Reg Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Stores a device register value.  
 <a href="classReg.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="adf4351_8h_source.html">adf4351.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4a4a5651833babfd0d525e41626833b1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReg.html#a4a4a5651833babfd0d525e41626833b1">Reg</a> ()</td></tr>
<tr class="separator:a4a4a5651833babfd0d525e41626833b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2506df1de4cfe1eb7823ca080707e3a8"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReg.html#a2506df1de4cfe1eb7823ca080707e3a8">get</a> ()</td></tr>
<tr class="separator:a2506df1de4cfe1eb7823ca080707e3a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a391898eea8c4c9c6597b5982d40dc014"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReg.html#a391898eea8c4c9c6597b5982d40dc014">set</a> (uint32_t value)</td></tr>
<tr class="separator:a391898eea8c4c9c6597b5982d40dc014"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb2d585cd22d9b790459d1f0ef6d69c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReg.html#abb2d585cd22d9b790459d1f0ef6d69c9">setbf</a> (uint8_t start, uint8_t len, uint32_t value)</td></tr>
<tr class="separator:abb2d585cd22d9b790459d1f0ef6d69c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8110b2b319905a36c6657c0cc8f6da1"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReg.html#ad8110b2b319905a36c6657c0cc8f6da1">getbf</a> (uint8_t start, uint8_t len)</td></tr>
<tr class="separator:ad8110b2b319905a36c6657c0cc8f6da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acb54e195092c824c1573f95f09d65b9c"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classReg.html#acb54e195092c824c1573f95f09d65b9c">whole</a></td></tr>
<tr class="separator:acb54e195092c824c1573f95f09d65b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Stores a device register value. </p>
<p>This class is used to store and manage a single <a class="el" href="classADF4351.html" title="ADF4351 chip device driver. ">ADF4351</a> register value and provide bit field manipulations. </p>

<p>Definition at line <a class="el" href="adf4351_8h_source.html#l00044">44</a> of file <a class="el" href="adf4351_8h_source.html">adf4351.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a4a4a5651833babfd0d525e41626833b1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Reg::Reg </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor</p>
<p>single register constructor </p>

<p>Definition at line <a class="el" href="adf4351_8cpp_source.html#l00059">59</a> of file <a class="el" href="adf4351_8cpp_source.html">adf4351.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a2506df1de4cfe1eb7823ca080707e3a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Reg::get </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>get the current register value returns same value as getbf(0,32) </p><dl class="section return"><dt>Returns</dt><dd>unsigned long value of the register </dd></dl>

<p>Definition at line <a class="el" href="adf4351_8cpp_source.html#l00064">64</a> of file <a class="el" href="adf4351_8cpp_source.html">adf4351.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ad8110b2b319905a36c6657c0cc8f6da1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Reg::getbf </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>start</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>gets the current register bitfield value, based on the start and length mask </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">start</td><td>index of the bit of where to start </td></tr>
    <tr><td class="paramname">len</td><td>length number of bits to get </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bitfield value </dd></dl>

<p>Definition at line <a class="el" href="adf4351_8cpp_source.html#l00082">82</a> of file <a class="el" href="adf4351_8cpp_source.html">adf4351.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a391898eea8c4c9c6597b5982d40dc014"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Reg::set </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>sets the register value </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>unsigned long </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adf4351_8cpp_source.html#l00069">69</a> of file <a class="el" href="adf4351_8cpp_source.html">adf4351.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abb2d585cd22d9b790459d1f0ef6d69c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Reg::setbf </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>start</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>modifies the register value based on a value and bitfield (mask) </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">start</td><td>index of the bit to start the modification </td></tr>
    <tr><td class="paramname">len</td><td>length number of bits to modify </td></tr>
    <tr><td class="paramname">value</td><td>value to modify (value is truncated if larger than len bits) </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="adf4351_8cpp_source.html#l00074">74</a> of file <a class="el" href="adf4351_8cpp_source.html">adf4351.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="acb54e195092c824c1573f95f09d65b9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Reg::whole</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>current register value</p>
<p>returns same value as getbf(0,32) </p>

<p>Definition at line <a class="el" href="adf4351_8h_source.html#l00067">67</a> of file <a class="el" href="adf4351_8h_source.html">adf4351.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="adf4351_8h_source.html">adf4351.h</a></li>
<li>src/<a class="el" href="adf4351_8cpp_source.html">adf4351.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classReg.html">Reg</a></li>
    <li class="footer">Generated on Sun Jul 1 2018 15:15:39 for ADF4351 by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
